home *** CD-ROM | disk | FTP | other *** search
/ JCSM Shareware Collection 1993 November / JCSM Shareware Collection - 1993-11.iso / cl720 / tsrtoo15.lzh / TSRTOO15.DOC < prev    next >
Text File  |  1993-09-04  |  24KB  |  323 lines

  1.     ------------------------------------------------------------------------
  2.     |                                                                      |
  3.     |                                                                      |
  4.     |                                                                      |
  5.     |                                                                      |
  6.     |                                                                      |
  7.     |                                                                      |
  8.     |                                                                      |
  9.     |                                                                      |
  10.     |                                                                      |
  11.     |                                                                      |
  12.     |                                                                      |
  13.     |                                                                      |
  14.     |                                                                      |
  15.     |                                                                      |
  16.     |                                                                      |
  17.     |                                                                      |
  18.     |                                                                      |
  19.     |                                                                      |
  20.     |                                                                      |
  21.     |                                                                      |
  22.     |                                                                      |
  23.     |                                                                      |
  24.     |                         T S R  T O O L K I T                         |
  25.     |                                                                      |
  26.     |                              Version 1.5                             |
  27.     |                                                                      |
  28.     |                Copyright (C) 1993, Geoff Friesen B.Sc.               |
  29.     |                         All rights reserved.                         |
  30.     |                                                                      |
  31.     |                                                                      |
  32.     |                                                                      |
  33.     |                                                                      |
  34.     |                                                                      |
  35.     |                                                                      |
  36.     |                                                                      |
  37.     |                                                                      |
  38.     |                                                                      |
  39.     |                                                                      |
  40.     |                                                                      |
  41.     |                                                                      |
  42.     |                                                                      |
  43.     |                                                                      |
  44.     |                                                                      |
  45.     |                                                                      |
  46.     |                                                                      |
  47.     |                                                                      |
  48.     |                                                                      |
  49.     |                                                                      |
  50.     |                                                                      |
  51.     |                                                                      |
  52.     ------------------------------------------------------------------------
  53.  
  54.     ------------------------------------------------------------------------
  55.     |                                                                      |
  56.     |                             Introduction                             |
  57.     |                             ------------                             |
  58.     |                                                                      |
  59.     | TSR (Terminate but Stay Resident) programs are useful tools but they |
  60.     | are not easy to write.  Over the past few years, I have explored TSR |
  61.     | development and perfected a toolkit which takes much of the pain out |
  62.     | of creating TSRs.  This toolkit is called TSR TOOLKIT.               |
  63.     |                                                                      |
  64.     | TSR TOOLKIT is more than a collection of files.  It is a methodology |
  65.     | for successfully building TSRs.  If you follow the rules, you should |
  66.     | experience very little trouble.                                      |
  67.     |                                                                      |
  68.     | In addition to TSR TOOLKIT, you will need a copy of Borland C++ v3.1 |
  69.     | or earlier.  Specifically, you must have a copy of BCC.EXE, TASM.EXE |
  70.     | and TLINK.EXE.  BCC is the Borland command line compiler, TASM is    |
  71.     | the Turbo Assembler, and TLINK is the Turbo Linker.  If your version |
  72.     | of TLINK does not support a /t switch to create a .COM file then you |
  73.     | will also need a copy of EXE2BIN.  TSRs created with TSR TOOLKIT can |
  74.     | be used with DOS version 3.30 and higher.                            |
  75.     |                                                                      |
  76.     | This document provides general information concerning the toolkit.   |
  77.     | You should consult TSR.DOC in TSR.ZIP, TSREX.DOC in TSREX.ZIP, and   |
  78.     | TSRLIB.DOC in TSRLIB.ZIP for more information.                       |
  79.     |                                                                      |
  80.     | Version 1.5 features include:                                        |
  81.     |                                                                      |
  82.     | 1) support for extended memory access                                |
  83.     | 2) mouse support (see CC.C in TSREX.ZIP for more information)        |
  84.     | 3) sound and timer support (see TSR.DOC in TSR.ZIP)                  |
  85.     | 4) improved documentation                                            |
  86.     | 5) more reliable kernels                                             |
  87.     |                                                                      |
  88.     | *** IMPORTANT                                                        |
  89.     |                                                                      |
  90.     | TSR created with TSR TOOLKIT must be uninstalled before you attempt  |
  91.     | to run Microsoft Windows 3.1.  Windows will not crash but it will    |
  92.     | not load due to a conflict via the XMS kernel within TSR TOOLKIT.  I |
  93.     | have not yet been able to resolve this conflict.  Also, TSR TOOLKIT  |
  94.     | TSRs have not been tested with DOSSHELL, Desqview, or other task     |
  95.     | switchers and multitaskers.                                          |
  96.     |                                                                      |
  97.     | When a DPMI-aware program such as BC.EXE (the Borland integrated     |
  98.     | environment compiler) is running, TSRs cannot access extended memory |
  99.     | via the XMS API (application program interface).  XMS functions will |
  100.     | return an error code.  I have not discovered how to solve this prob- |
  101.     | lem.  Any ideas?                                                     |
  102.     |                                                                      |
  103.     |                                                                      |
  104.     |                                                                      |
  105.     ------------------------------------------------------------------------
  106.                       - 2 -
  107.  
  108.     ------------------------------------------------------------------------
  109.     |                                                                      |
  110.     |                             Installation                             |
  111.     |                             ------------                             |
  112.     |                                                                      |
  113.     | TSR TOOLKIT contains a collection of 100 files that have been organ- |
  114.     | ized into several archives as follows.                               |
  115.     |                                                                      |
  116.     | TSRTOO.ZIP                                                           |
  117.     |   TSRTOO15.DOC  - overall documentation                              |
  118.     |   TSR.ZIP                                                            |
  119.     |     TSR.DOC     - TSR structure and utilities documentation          |
  120.     |     T.BAT                                                            |
  121.     |     TSR.C                                                            |
  122.     |     TSR.EXE                                                          |
  123.     |     FILTER.C                                                         |
  124.     |     FILTER.EXE                                                       |
  125.     |     EXTRA.ASM                                                        |
  126.     |   TSREX.ZIP                                                          |
  127.     |     TSREX.DOC   - examples documentation                             |
  128.     |     ASCII.C                                                          |
  129.     |     ASCII.COM                                                        |
  130.     |     CC.C                                                             |
  131.     |     CC.COM                                                           |
  132.     |     CP.C                                                             |
  133.     |     CP.COM                                                           |
  134.     |     FF.C                                                             |
  135.     |     FF.COM                                                           |
  136.     |     FTALLY.C                                                         |
  137.     |     FTALLY.COM                                                       |
  138.     |     HOTKEY.C                                                         |
  139.     |     HOTKEY.COM                                                       |
  140.     |     INT2148.C                                                        |
  141.     |     INT2148.COM                                                      |
  142.     |     XMS.C                                                            |
  143.     |     XMS.COM                                                          |
  144.     |   TSRLIB.ZIP                                                         |
  145.     |     TSRLIB.DOC  - library documentation                              |
  146.     |     TSRLIB.H                                                         |
  147.     |     ATOI.C                                                           |
  148.     |     ATOL.C                                                           |
  149.     |     ATTRIB.C                                                         |
  150.     |     CHDIR.C                                                          |
  151.     |     CHMOD.C                                                          |
  152.     |     CLOSE.C                                                          |
  153.     |     CREAT.C                                                          |
  154.     |     FILELENG.C                                                       |
  155.     |     FIND.C                                                           |
  156.     |     FORMAT.C                                                         |
  157.     |     GETCURDI.C                                                       |
  158.     |     GETDATE.C                                                        |
  159.     ------------------------------------------------------------------------
  160.                       - 3 -
  161.  
  162.     ------------------------------------------------------------------------
  163.     |                                                                      |
  164.     |     GETDISK.C                                                        |
  165.     |     GETSTR.C                                                         |
  166.     |     GETTIME.C                                                        |
  167.     |     GETVECT.C                                                        |
  168.     |     ISALNUM.C                                                        |
  169.     |     ISALPHA.C                                                        |
  170.     |     ISDIGIT.C                                                        |
  171.     |     ISLEAP.C                                                         |
  172.     |     ISLOWER.C                                                        |
  173.     |     ISSPACE.C                                                        |
  174.     |     ISUPPER.C                                                        |
  175.     |     ISXDIGIT.C                                                       |
  176.     |     ITOA.C                                                           |
  177.     |     KFETCH.C                                                         |
  178.     |     KISKEY.C                                                         |
  179.     |     LSEEK.C                                                          |
  180.     |     LTOA.C                                                           |
  181.     |     MEMSWAP.C                                                        |
  182.     |     MKDIR.C                                                          |
  183.     |     OPEN.C                                                           |
  184.     |     READ.C                                                           |
  185.     |     RENAME.C                                                         |
  186.     |     RMDIR.C                                                          |
  187.     |     SETDATE.C                                                        |
  188.     |     SETDISK.C                                                        |
  189.     |     SETTIME.C                                                        |
  190.     |     SETVECT.C                                                        |
  191.     |     SPRINTF.C                                                        |
  192.     |     STRCMP.C                                                         |
  193.     |     STRCPY.C                                                         |
  194.     |     STRICMP.C                                                        |
  195.     |     STRLEN.C                                                         |
  196.     |     STRLWR.C                                                         |
  197.     |     STRNCMP.C                                                        |
  198.     |     STRNCPY.C                                                        |
  199.     |     STRNICMP.C                                                       |
  200.     |     STRREV.C                                                         |
  201.     |     STRUPR.C                                                         |
  202.     |     TELL.C                                                           |
  203.     |     TOLOWER.C                                                        |
  204.     |     TOUPPER.C                                                        |
  205.     |     UCURSOR.C                                                        |
  206.     |     UNLINK.C                                                         |
  207.     |     VAA.C                                                            |
  208.     |     VBORDER.C                                                        |
  209.     |     VCPRINTF.C                                                       |
  210.     |     VCPUTS.C                                                         |
  211.     |     VGETATTR.C                                                       |
  212.     |     VGETMODE.C                                                       |
  213.     ------------------------------------------------------------------------
  214.                       - 4 -
  215.  
  216.     ------------------------------------------------------------------------
  217.     |                                                                      |
  218.     |     VGETSHAP.C                                                       |
  219.     |     VGOTOXY.C                                                        |
  220.     |     VPAINT.C                                                         |
  221.     |     VPUTCH.C                                                         |
  222.     |     VSCREEN.C                                                        |
  223.     |     VSCROLL.C                                                        |
  224.     |     VSETATTR.C                                                       |
  225.     |     VSETSHAP.C                                                       |
  226.     |     VSHADOW.C                                                        |
  227.     |     VWHEREX.C                                                        |
  228.     |     VWHEREY.C                                                        |
  229.     |     WRITE.C                                                          |
  230.     |                                                                      |
  231.     | Installation is fairly straightforward.  You need about 600,000 free |
  232.     | bytes of hard disk space.                                            |
  233.     |                                                                      |
  234.     | 1. Make a directory below the root directory and call it TSR.        |
  235.     | 2. Copy TSRTOO.ZIP to this directory and unzip with PKUNZIP.         |
  236.     | 3. Make three directories below TSR called TSR, TSREX, and TSRLIB.   |
  237.     | 4. Copy TSR.ZIP to TSR, TSREX.ZIP to TSREX, and TSRLIB.ZIP to TSRLIB |
  238.     | 5. Unzip these archives.                                             |
  239.     | 6. Set the environment variable TI to the path \TSR\TSRLIB so that   |
  240.     |    T.BAT can tell BCC.EXE where to find TSRLIB #include files.       |
  241.     | 7. Place \TSR\TSR onto your PATH variable so that utility programs   |
  242.     |    can be accessed from any directory.                               |
  243.     | 8. Create a directory for building your own projects (below TSR) and |
  244.     |    copy EXTRA.ASM to this directory.                                 |
  245.     | 9. Erase the .ZIP files.                                             |
  246.     |                                                                      |
  247.     | This completes installation.                                         |
  248.     |                                                                      |
  249.     |                                                                      |
  250.     |                                                                      |
  251.     |                                                                      |
  252.     |                                                                      |
  253.     |                                                                      |
  254.     |                                                                      |
  255.     |                                                                      |
  256.     |                                                                      |
  257.     |                                                                      |
  258.     |                                                                      |
  259.     |                                                                      |
  260.     |                                                                      |
  261.     |                                                                      |
  262.     |                                                                      |
  263.     |                                                                      |
  264.     |                                                                      |
  265.     |                                                                      |
  266.     |                                                                      |
  267.     ------------------------------------------------------------------------
  268.                       - 5 -
  269.  
  270.     ------------------------------------------------------------------------
  271.     |                                                                      |
  272.     |                               Shareware                              |
  273.     |                               ---------                              |
  274.     |                                                                      |
  275.     | TSR TOOLKIT is the result of alot of work.  This toolkit is being    |
  276.     | distributed as shareware.  The shareware approach to distribution    |
  277.     | gives you an opportunity to "try before you buy".  If you like this  |
  278.     | product and intend to use it then you are requested to register your |
  279.     | copy.  Registration is a simple process and does have an advantage.  |
  280.     | Basically, you would send a check or money order in the amount of    |
  281.     | twenty dollars to myself at the address shown below.  In return, I   |
  282.     | promise to personally send you a copy of version 1.6 when it becomes |
  283.     | available.  TSR TOOLKIT will be available from many fine shareware   |
  284.     | distributors but you may not be aware of future versions as soon as  |
  285.     | they become available.  Registration guarantees that you will not    |
  286.     | miss the next version.                                               |
  287.     |                                                                      |
  288.     | I am very proud of this product and intend to support it as long as  |
  289.     | it serves a purpose.  I have plans for the next version which I will |
  290.     | briefly discuss.  I also invite you to contribute ideas to improve   |
  291.     | this product.                                                        |
  292.     |                                                                      |
  293.     | I would like to focus the next version on computer graphics, sound   |
  294.     | blaster music, and computer games.  I also want to make this product |
  295.     | even more reliable while maintaining compatibility with all previous |
  296.     | versions.  If you discover problems with this toolkit and have found |
  297.     | solutions then I would appreciate your sharing this information with |
  298.     | me so that I can add this to the next version.  Everyone benefits.   |
  299.     |                                                                      |
  300.     | TSR TOOLKIT is under copyright.  If you distribute this product then |
  301.     | include all files in an unmodified state.  Keep the original archive |
  302.     | structure intact.  As a registered user, you are granted the right   |
  303.     | to modify TSR TOOLKIT according to your needs and sell your own TSRs |
  304.     | without royalties.                                                   |
  305.     |                                                                      |
  306.     | My address is:                                                       |
  307.     |                                                                      |
  308.     | Geoff Friesen                                                        |
  309.     | Box 94                                                               |
  310.     | Dauphin, MB                                                          |
  311.     | Canada R7N 2T9                                                       |
  312.     |                                                                      |
  313.     | My Compuserve id is:                                                 |
  314.     |                                                                      |
  315.     | 71203,332                                                            |
  316.     |                                                                      |
  317.     | When registering, please specify the size of disk you want sent con- |
  318.     | taining version 1.6.                                                 |
  319.     |                                                                      |
  320.     |                      Thankyou for your support.                      |
  321.     ------------------------------------------------------------------------
  322.                       - 6 -
  323.